julian+alberto classlib merges for 3.4 (10125, 10130, 10133)
[supercollider.git] / README OS X
blobc4f58b4ac15e91c0cfd8508ddb2c456a908d2503
1 ------------------------------------------------------------------------
2 Introduction
3 ------------------------------------------------------------------------
5 This is the Mac OS X version of James McCartney's SuperCollider
6 synthesis engine (scsynth) and programming language (sclang).
7 Supercollider's main homepage is at:
9    http://supercollider.sourceforge.net/
11 To get further information on SuperCollider usage or development, you
12 should subscribe to the mailing lists:
14    http://swiki.hfbk-hamburg.de:8888/MusicTechnology/880
16 Do not use non-ASCII characters (above code point 127) in your SuperCollider program path. Doing so will break options to open class or method files automatically.
18 ------------------------------------------------------------------------
19 System Requirements
20 ------------------------------------------------------------------------
22 Mac OS X 10.4.9 or greater
23 Xcode Tools 2.4.1 or greater
25 ------------------------------------------------------------------------
26 Building
27 ------------------------------------------------------------------------
29 The easy way:
30         ./clean-compile.sh
31         ./package.sh
33 Your build will be placed in a directory named "SuperCollider".
35 If you run into problems building the most likely cause is that you are
36 not running the correct version of the Xcode tools. You must be running
37 2.4.1 or above!
39 Building within Xcode:
40         There are three projects that should be BUILT IN THIS ORDER:
42         Synth
43          - the synthesis server application
45         Plugins
46          - the UGens and plugins
48         Language
49          - the OS X application with text editor, language interpreter,
50            event scheduling etc.
52 The package.sh script does several maintenance tasks (fixing creator
53 codes, exporting from svn, etc) and creates a ready-to-distribute zip of
54 SuperCollider.
56 ------------------------------------------------------------------------
57 On libsndfile
58 ------------------------------------------------------------------------
60 Compiling a universal binary of libsndfile requires access to both a
61 i386 and PPC Mac. The reasons for this are described here:
63 http://www.mega-nerd.com/libsndfile/FAQ.html#Q018
65 Because of this, libsndfile is included with the source as a precompiled
66 universal binary. This UB contains ppc, i386 and x86_64 archs.
68 ------------------------------------------------------------------------
69 Building - 10.6 and 64-bit scsynth and plugins
70 ------------------------------------------------------------------------
72 You will need to do the following to build a 64-bit scsynth and plugins.
73 Open the XCode projects for Synth and Plugins
74 Double-click each target, and change the
75         Architectures setting to 'Standard (32-bit/64-bit Universal)
76         Base-SDK to 10.5
77         (optional and recommended): Compiler to GCC 4.2 (if available)
79 This definitely works in Mac OS 10.6, probably 10.5, and these builds will NOT support 10.4
81 XCode in 10.6 uses the GCC 4.2 compiler by default, and this compiler will NOT work with the 10.4 SDK (the default SDK). You will need to either set your build SDK to 10.5 or 10.6 inside each XCode project, or inspect (double-click) each target and set GCC 4.0 as your compiler.
83 UPDATE - There is now a Deployment32-64 build style that should build SuperCollider from source out of the box on 10.6. You can also use the compile.sh script and pass in ARCHS=32_64 as a flag:
84     ./compile.sh ARCHS=32_64
85 This should build a 32/64 bit version of scsynth and the plugins and a 32-bit SuperCollider.app. This build style should use the 10.5 SDK by default.
87 The 10.6 SDK still has some problems. If you are on 10.6, please make sure you have installed the 10.5 SDK installed with the developer tools.
89 ------------------------------------------------------------------------
90 Outro
91 ------------------------------------------------------------------------
93 Thanks to James McCartney, for making this great piece of audio
94 software publicly and freely available.
96 ------------------------------------------------------------------------